Scripting

Scripting

TUGZip V3 introduces an update to the popular scripting engine. This documentation will give you the information needed to create your own scripts.

How does it work?

All communication with the engine (TzScript.exe) is through TUGZip script files (*.tzs). The script files full path are passed as the parameter when launching TzScript.exe, if no parameter is used you will receive an error message telling you that an invalid parameter was used. The script files are then compiled and translated by the TzScript.exe and it will perform the actions that you have requested in the script.

What do the scripts look like?

The script files are written in JavaScript. The function that is called by the script engine is the "main" function. All scripts must have a function with this name. There are no restrictions, if you want to create your own functions, go ahead.

Example.tzs

function main()
{
     var Decomp = new Decompress();

     Decomp.Archive = "C:\\MyArchive.zip";
     Decomp.Target = "C:\\Temp\\";
     Decomp.CreateFolders = 1;
     Decomp.Overwrite = 0;

     Decomp.DoDecompress();
}

Classes

Functions